home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / comm / spar372.zip / SPAR.DOC < prev    next >
Text File  |  1994-02-05  |  9KB  |  232 lines
  1.  
  2.  
  3.                                 SPAR V37.2 beta
  4.  
  5.                     A Sana-II compatible PARnet device driver
  6.  
  7.                                 by S.A. Pechler
  8.  
  9.  
  10. Warning
  11.  
  12.      The current status of SPAR is: experimental. It is tested with
  13.      only a few applications and some parnet device versions. Please
  14.      report to me any bugs you find (my address is given below). I have
  15.      included a debug version of SPAR, called spardebug.device. When
  16.      using this device a window will be opened in which a lot of
  17.      debugging information is shown. Correct interpretation of this
  18.      information requires a broad knowledge of the Sana-II device.
  19.  
  20.  
  21. Disclaimer
  22.  
  23.      This information is provided ``As Is'' without warranty of any
  24.      kind, either express or implied.  The entire risk as to the use of
  25.      this information is assumed by the user.  In no event will
  26.      Commodore or its affiliated companies be liable for any damages,
  27.      direct, indirect, incidental, special or consequential, resulting
  28.      from any claim arising out of the information presented herein,
  29.      even if it has been advised of the possibility of such damages. 
  30.      Some states do not allow the exclusion or limitation of such
  31.      implied warranties, so the above limitations may not apply.
  32.  
  33.  
  34. General Overview
  35.  
  36.      SPAR is a Sana-II compatible device driver for PARnet networks. It
  37.      allows you to make connections over a PARnet line with any network
  38.      protocol stack. It is created as a 'front-end' device, i.e. it
  39.      calls the parnet.device for low-level communications (PARnet is not
  40.      integrated). The advantage of this method is that you can use any
  41.      version of the parnet.device, even the versions that are patched
  42.      for multi parallel boards.
  43.      The Spar device can be used with all applications that support the
  44.      Sana-II standard, like AS225, Envoy, AmiTCP, etc.
  45.  
  46.  
  47. System requirements
  48.  
  49.      To let SPAR function properly on your system, you need at least:
  50.  
  51.      - Kickstart V2.04 or higher.
  52.      - parnet.device from the Software Distillery (any version will do)
  53.      - Networking software that support SANA-II devices (like AS225)
  54.      - For re-compiling the source code: SAS C V6+ (or Lattice C)
  55.  
  56.  
  57. Software installation
  58.  
  59.      Due to the experimental state of this program, I've not written an
  60.      Installer script yet. You need to do the following things by hand:
  61.  
  62.      Place the device driver 'spar.device' in DEVS:Networks and
  63.      'parnet.device' in DEVS:
  64.  
  65.      Next, copy the spar0.config file to ENVARC:Sana2/spar0.config. If
  66.      you are going to use multiple SPAR units, you will need a
  67.      separate configuration file for each unit. The file's are named
  68.      spar[unit number].config. So, SPAR unit 5 would have a
  69.      configuration file named spar5.config. Currently, there is a
  70.      limitation of eight SPAR units, 0-7.
  71.  
  72.      In the configuration file you can modify the following 4 arguments:
  73.  
  74.      PARNAME: The name of the parnet device to be used (in most cases
  75.               parnet.device).
  76.      PARUNIT: The unit of the parnet device (in most cases 0).
  77.      PARADDR: The PARnet hardware address of this machine (1-254).
  78.               Each machine on the same PARnet network must have a uniq
  79.               address, this is done by taking the last octet in the
  80.               machine's IP-address. e.g. When your machine has the IP
  81.               address 131.155.12.15, then take 15 as hardware address.
  82.      DSTADDR: The PARnet hardware address of the other machine.
  83.               This argument is optional. When you have only 2 machines
  84.               connected with a PARnet cable it is advisable to fill in
  85.               this argument. It gives more compatibility with Ethernet-
  86.               like devices (packet broadcast will be supported).
  87.  
  88.  
  89. SPAR Usage
  90.  
  91.      SPAR is currently only tested with Commodore's AS225 V2.5 beta and
  92.      AmiTCP V2.2. So I can only give some notes about using SPAR with
  93.      these two programs. 
  94.  
  95.  
  96.      AS225:
  97.  
  98.      If you are using the spar.device with AS225, you need to add a new
  99.      entry to your inet:s/sana2_devs file. IP type and ARP type must be
  100.      set to their Ethernet equivalent (IPType: 2048, ARPType: 2054).
  101.  
  102.      An example entry in inet:s/sana2_devs:
  103.      devs:networks/spar.device    0  2048     2054   # Sana-II PARnet device
  104.  
  105.      Add the following line to your networking startup file (right after
  106.      the 'config host & user' commands):
  107.  
  108.      inet:c/ifconfig s# $hostname netmask <yournetmask>  -trailers
  109.  
  110.      Substitute the # with the corresponding interface entry number of
  111.      SPAR in inet:s/sana2_devs.
  112.  
  113.      Substitute <yournetmask> with the correct netmask for your network.
  114.  
  115.  
  116.      AmiTCP:
  117.  
  118.      Edit the AmiTCP startup script (default in AmiTCP:bin/startnet) and
  119.      add the following entry behind the configuration of the loopback
  120.      interface (lo): 
  121.  
  122.      (this line is wrapped, put everything on one line in the script):
  123.      AmiTCP:bin/ifconfig Devs:Networks/spar.device/0 inet <yourIPaddr>
  124.      netmask <yournetmask> -trailers
  125.  
  126.      Substitute <yourIPaddr> with the IP adresses you want to give to this
  127.      interface. Be sure that the hardware address of the PARnet device
  128.      corresponds with the last octet in this IP address.
  129.  
  130.      Substitute <yournetmask> with the correct netmask for your network.
  131.  
  132.  
  133.      Envoy:
  134.  
  135.      (I've taken these remarks from the Slip installation documentation. It
  136.       has never really been tried with Spar).
  137.  
  138.      If you are using the spar.device with Envoy, you need to use the
  139.      NIPC Configuration Editor to add spar.device to nipc's list of
  140.      devices. Select 'Use defaults' for IP Type and ARP Type.
  141.  
  142.  
  143. Error Messages
  144.  
  145.      The SPAR device driver can give error messages when a 'fatal'
  146.      error occures (The driver can't continue operation). Such messages
  147.      appear in an Intiuition 'Easy-Requester' on the workbench screen.
  148.      You can get the follwing errors:
  149.  
  150.      "Invalid hardware address (XXX) given."
  151.      You've placed a wrong number in the HWADDR field of the
  152.      ENVARC:Sana2/spar#.config file (# = SPAR Unit). This number can
  153.      only be in the range 1-254.
  154.  
  155.      "Error in configuration file on line XXX."
  156.      The configuration in ENVARC:Sana2/spar#.config is given in an
  157.      incorrect format. It could also be possible that a comment marker
  158.      is placed wrong.
  159.  
  160.      "Couldn't open XXX unit Y."
  161.      The device with unit number given in ENV:Sana2/spar#.config could
  162.      not be opened. Check if this device (in most cases parnet.device)
  163.      is located in the DEVS: directory.
  164.  
  165.  
  166. Limitations of SPAR
  167.  
  168.      Since SPAR is running 'above' PARnet, it has the same limitations
  169.      as the parnet.device.
  170.  
  171.      - SPAR does not support network broadcasting, this means that it
  172.        normally can't handle ARP and RIP protocols.
  173.        To solve this problem on a 2-host network the 'DSTADDR' field
  174.        in the spar#.config file must be filled in (See 'software 
  175.        installation').
  176.        When using more than 2 hosts the 'DSTADDR' can not be used, in
  177.        this case an ARP request will be processed by the spar.device on
  178.        the local host. The hardware address of the remote host will be
  179.        resolved from the last octet in the IP address of that host.
  180.  
  181.      - The network is limited to max. 3 machines on the same PARnet
  182.        cable. Additional hardware buffering is needed to allow more.
  183.  
  184.      - SPAR uses only 1-byte hardware addresses. But for applications
  185.        which uses Ethernet style addressing methods, the address can
  186.        be 'embedded'. This is done by using only the first byte of the
  187.        ethernet address as the SPAR hardware address and clearing
  188.        all other 5 bytes to zero.
  189.  
  190.  
  191. SPAR and NET: file system
  192.  
  193.      It is not possible to use both the NET: file system from The
  194.      Software Distillery and SPAR at the same time. The NET: server
  195.      seems to change the network hardware address of the parnet unit.
  196.      I tried to use different units and hardware addresses, but it did
  197.      not work together. There is an alternative for the NET: file system,
  198.      called PARnfs. It's available on all Aminet FTP sites.
  199.  
  200.  
  201. History
  202.  
  203.      V37.2 931217 Bugfixes in the code, merged in some code from the
  204.                   rhslip.device from Olaf 'Rhialto' Seibert (see also
  205.                   history.txt). Added ARP support and limited packet
  206.                   broadcast.
  207.      V37.1 930824 Experimental version, first release.
  208.  
  209.  
  210. Copyright notices
  211.  
  212.      The SANA-II Network Device Driver specification is (C) Copyright
  213.      1992 by Commodore-Amiga, Inc. All Rights Reserved.
  214.      The parnet.device and NET: file system are Copyright (C) 1988,
  215.      1989, 1990 by The Software Distillery.
  216.      Ethernet is a trademark of Xerox Corporation.
  217.  
  218.  
  219. Contacts
  220.  
  221.      If you have comments/bugreports/complaints/... about SPAR, please
  222.      send them to:
  223.  
  224.  
  225.      Paper mail          E-mail
  226.      ----------          -----
  227.      S.A. Pechler        BITnet  : BDAASP@HEITUE51
  228.      Diederikstraat 66   INternet: bdaasp@urc.tue.nl 
  229.      NL-5421 EX Gemert   UUCP    : ..!mcsun!sun4nl!rc5.urc.tue.nl!bdaasp
  230.      The Netherlands     X.400   : c=nl;admd=400net;prmd=surf;o=tue;
  231.                                    ou=urc;s=bdaasp
  232.